FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/ObservationPeriod

Packagehl7.fhir.uv.omop
Resource TypeStructureDefinition
IdObservationPeriod
FHIR VersionR5
Sourcehttp://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-ObservationPeriod.html
URLhttp://hl7.org/fhir/uv/omop/StructureDefinition/ObservationPeriod
Version1.0.0-ballot
Statusactive
Date2025-07-29T17:40:15+00:00
NameObservationPeriod
TitleObservation Period OMOP Table
Realmuv
Authorityhl7
DescriptionThis table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.
Typehttp://hl7.org/fhir/uv/omop/StructureDefinition/ObservationPeriod
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
PersonPerson OMOP Table

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ObservationPeriod

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationPeriod 0..*BaseObservation Period OMOP Table
Instances of this logical model can be the target of a Reference
... observation_period_id 1..1integerObservation Period Identifier
... person_id 1..1Reference(Person OMOP Table)Person
... observation_period_start_date 1..1dateStart Date
... observation_period_end_date 1..1dateEnd Date
... period_type_concept_id 1..1codePeriod Type

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ObservationPeriod",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-be-target"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "brr"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/ObservationPeriod",
  "version": "1.0.0-ballot",
  "name": "ObservationPeriod",
  "title": "Observation Period OMOP Table",
  "status": "active",
  "date": "2025-07-29T17:40:15+00:00",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "contact": [
    {
      "name": "HL7 International / Biomedical Research and Regulation",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/rcrim"
        }
      ]
    }
  ],
  "description": "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/ObservationPeriod",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "ObservationPeriod",
        "path": "ObservationPeriod",
        "short": "Observation Period OMOP Table",
        "definition": "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ObservationPeriod.observation-period-id",
        "path": "ObservationPeriod.observation_period_id",
        "short": "Observation Period Identifier",
        "definition": "A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ObservationPeriod.observation_period_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ObservationPeriod.person-id",
        "path": "ObservationPeriod.person_id",
        "short": "Person",
        "definition": "The Person ID of the PERSON record for which the Observation Period is recorded.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ObservationPeriod.person_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "ObservationPeriod.observation-period-start-date",
        "path": "ObservationPeriod.observation_period_start_date",
        "short": "Start Date",
        "definition": "Use this date to determine the start date of the Observation Period.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ObservationPeriod.observation_period_start_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ObservationPeriod.observation-period-end-date",
        "path": "ObservationPeriod.observation_period_end_date",
        "short": "End Date",
        "definition": "Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ObservationPeriod.observation_period_end_date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ObservationPeriod.period-type-concept-id",
        "path": "ObservationPeriod.period_type_concept_id",
        "short": "Period Type",
        "definition": "This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ObservationPeriod.period_type_concept_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ObservationPeriod",
        "path": "ObservationPeriod",
        "short": "Observation Period OMOP Table",
        "definition": "This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time."
      },
      {
        "id": "ObservationPeriod.observation-period-id",
        "path": "ObservationPeriod.observation_period_id",
        "short": "Observation Period Identifier",
        "definition": "A Person can have multiple discrete Observation Periods which are identified by the Observation_Period_Id.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "ObservationPeriod.person-id",
        "path": "ObservationPeriod.person_id",
        "short": "Person",
        "definition": "The Person ID of the PERSON record for which the Observation Period is recorded.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
            ]
          }
        ]
      },
      {
        "id": "ObservationPeriod.observation-period-start-date",
        "path": "ObservationPeriod.observation_period_start_date",
        "short": "Start Date",
        "definition": "Use this date to determine the start date of the Observation Period.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ObservationPeriod.observation-period-end-date",
        "path": "ObservationPeriod.observation_period_end_date",
        "short": "End Date",
        "definition": "Use this date to determine the end date of the period for which we can assume that all events for a Person are recorded.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ObservationPeriod.period-type-concept-id",
        "path": "ObservationPeriod.period_type_concept_id",
        "short": "Period Type",
        "definition": "This field can be used to determine the provenance of the Observation Period as in whether the period was determined from an insurance enrollment file, EHR healthcare encounters, or other sources.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      }
    ]
  }
}